package com.google.code.mochaccino.framework.crypto.cipher;

/*
 * Copyright 2012 Claude Houle claude.houle@gmail.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.security.GeneralSecurityException;
import javax.crypto.Cipher;

/**
 * The Cipher Handler interface is implemented so that you may customize
 * the way the cipher handles the data. It is a known fact that not all cipher
 * are equal in this regard, therefore you can provide exactly the way you want it.
 * <p/>
 * However, there are 3 existing implementation that should do the trick:
 * <ul>
 * <li>CipherHandlerBlockDoFinal</li>
 * <li>CipherHandlerBlockUpdate</li>
 * <li>CipherHandlerDoFinal</li>
 * </ul>
 */
public interface CipherHandler {

	/** transcode the input bytes into the output format. */
	public byte[] transform( Cipher c, byte[] data ) throws GeneralSecurityException, IOException;

	/**
	 * transcode the input bytes into the output format. Note that the input stream and output stream will not be closed. You still
	 * need to perform your own cleanup
	 */
	public void transform( Cipher c, InputStream in, OutputStream out ) throws GeneralSecurityException, IOException;
}
